docs: fix inaccuracies and language issues in action.yml and README#1337
Open
kranthipoturaju wants to merge 1 commit into
Open
docs: fix inaccuracies and language issues in action.yml and README#1337kranthipoturaju wants to merge 1 commit into
kranthipoturaju wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation and metadata text for the stale action to better match current behavior and improve wording/grammar across the repository.
Changes:
- Updates
action.ymlinput/output descriptions (syntax fixes, clarified semantics, and normalized phrasing). - Fixes wording and branding/grammar issues in
README.mdandCONTRIBUTING.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
action.yml |
Refines action name plus multiple input/output descriptions shown in the GitHub Actions UI. |
README.md |
Fixes wording/grammar in a few option descriptions and the v10 breaking change note. |
CONTRIBUTING.md |
Fixes branding and minor grammar/punctuation in contributor instructions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
520
to
+521
| If set to `true`, the pull requests currently in draft will not be marked as stale automatically. | ||
| ⚠️ This option consume one operation per pull request to process because we need to fetch the pull request with the GitHub API to know if it's a draft one or not. | ||
| ⚠️ This option consumes one operation per pull request to process because we need to fetch the pull request with the GitHub API to know if it's a draft one or not. |
Comment on lines
31
to
34
| days-before-close: | ||
| description: 'The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests.' | ||
| description: 'The number of days to wait to close an issue or a pull request after it being marked stale. Must be an integer. Set to -1 to never close stale issues or pull requests.' | ||
| required: false | ||
| default: '7' |
Comment on lines
35
to
40
| days-before-issue-close: | ||
| description: 'The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.' | ||
| description: 'The number of days to wait to close an issue after it being marked stale. Must be an integer. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues.' | ||
| required: false | ||
| days-before-pr-close: | ||
| description: 'The number of days to wait to close a pull request after it being marked stale. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.' | ||
| description: 'The number of days to wait to close a pull request after it being marked stale. Must be an integer. Set to -1 to never close stale pull requests. Override "days-before-close" option regarding only the pull requests.' | ||
| required: false |
| required: false | ||
| operations-per-run: | ||
| description: 'The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).' | ||
| description: 'The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related). Must be an integer.' |
Comment on lines
211
to
214
| only-issue-types: | ||
| description: 'Only issues with a matching type are processed as stale/closed. Defaults to `[]` (disabled) and can be a comma-separated list of issue types.' | ||
| default: '' | ||
| required: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes a collection of inaccuracies, broken syntax, and language issues across
action.yml,README.md, andCONTRIBUTING.md. No behavior or logic changes — documentation only.Changes
action.ymlrepo-tokendescription: fixed broken template expression ({{→${{)ignore-updates/ignore-issue-updates/ignore-pr-updates: descriptions were inverted — they described what happens when the option isfalse(the default), not what enabling it does; rewrote to accurately state that setting totrueswitches staleness calculation fromupdated_attocreated_atclose-issue-reason: documented the two valid values (completed,not_planned) and that an invalid value causes the action to fail (enforced inmain.ts)days-before-close/days-before-issue-close/days-before-pr-close/operations-per-run: added "Must be an integer" — all four useparseIntwith explicit NaN validation that callscore.setFaileddays-before-stale: added note that fractional values are accepted (usesparseFloat)only-issue-labels/only-pr-labels/only-issue-types: corrected default from[]to''— the actual default is an empty stringsort-by: documented that unrecognised values silently fall back tocreatedrather than erroringstart-date: documented that an invalid date format fails the actionexempt-draft-pr: corrected stale note — since June 2022 the draft flag is read from the issue list payload; no additional API call is madeexempt-all-milestones/exempt-all-assignees: normalised "Default to false" → "Defaults tofalse"JSON.stringify-encoded); reordered to match declaration order inmain.tsREADME.mdnode20/node 24→Node.js 20/Node.js 24(canonical branding)comma separated→comma-separatedin five option descriptions (compound modifier rule)consume→consumes,display→displaysIf you reached the limit→If you reach the limitCONTRIBUTING.mdtypescript→TypeScripta bump of version will happen→the version will be bumpedOtherwise, PR checks will fail.Impact
action.ymldescriptions surface in the GitHub Actions UI and autocomplete, reducing misconfigurationignore-updatesfix: the corrected description may change how users understand and set this option — previously the description implied the opposite of whattruedoesTesting
These are documentation-only changes with no executable code modifications.
Verified by cross-referencing each description against the corresponding
core.getInputcall insrc/main.ts, theIIssuesProcessorOptionsinterface, and the processing logic insrc/classes/issues-processor.ts.Related issue:
No issue was created as the changes are documentation only changes.
Check list: